<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AppendResponse.html 939 2015-05-29 01:16:17Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.raft.msg;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.base.Preconditions;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.nio.ByteBuffer;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jsimpledb.kv.raft.Timestamp;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jsimpledb.util.LongEncoder;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>/**<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Sent from a follower to a leader in response to an {@link AppendRequest}.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Also contains information about the follower's log.<a name="line.21"></a>
<span class="sourceLineNo">022</span> */<a name="line.22"></a>
<span class="sourceLineNo">023</span>public class AppendResponse extends Message {<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>    private final Timestamp leaderTimestamp;        // leaderTimestamp from corresponding AppendRequest<a name="line.25"></a>
<span class="sourceLineNo">026</span>    private final boolean success;                  // true if previous log entry term and index matched<a name="line.26"></a>
<span class="sourceLineNo">027</span>    private final long matchIndex;                  // index of higest log entry known to match leader<a name="line.27"></a>
<span class="sourceLineNo">028</span>    private final long lastLogIndex;                // the index of the last log entry in follower's log<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>// Constructors<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Constructor.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     *<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @param clusterId cluster ID<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @param senderId identity of sender<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @param recipientId identity of recipient<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * @param term sender's current term<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * @param leaderTimestamp copy of {@link AppendRequest#getLeaderTimestamp}<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * @param success if request successfully matched<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @param matchIndex highest known matching log index<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @param lastLogIndex index of follower's last log entry<a name="line.42"></a>
<span class="sourceLineNo">043</span>     */<a name="line.43"></a>
<span class="sourceLineNo">044</span>    public AppendResponse(int clusterId, String senderId, String recipientId, long term, Timestamp leaderTimestamp,<a name="line.44"></a>
<span class="sourceLineNo">045</span>      boolean success, long matchIndex, long lastLogIndex) {<a name="line.45"></a>
<span class="sourceLineNo">046</span>        super(Message.APPEND_RESPONSE_TYPE, clusterId, senderId, recipientId, term);<a name="line.46"></a>
<span class="sourceLineNo">047</span>        this.leaderTimestamp = leaderTimestamp;<a name="line.47"></a>
<span class="sourceLineNo">048</span>        this.success = success;<a name="line.48"></a>
<span class="sourceLineNo">049</span>        this.matchIndex = matchIndex;<a name="line.49"></a>
<span class="sourceLineNo">050</span>        this.lastLogIndex = lastLogIndex;<a name="line.50"></a>
<span class="sourceLineNo">051</span>        this.checkArguments();<a name="line.51"></a>
<span class="sourceLineNo">052</span>    }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    AppendResponse(ByteBuffer buf) {<a name="line.54"></a>
<span class="sourceLineNo">055</span>        super(Message.APPEND_RESPONSE_TYPE, buf);<a name="line.55"></a>
<span class="sourceLineNo">056</span>        this.leaderTimestamp = Message.getTimestamp(buf);<a name="line.56"></a>
<span class="sourceLineNo">057</span>        this.success = Message.getBoolean(buf);<a name="line.57"></a>
<span class="sourceLineNo">058</span>        this.matchIndex = LongEncoder.read(buf);<a name="line.58"></a>
<span class="sourceLineNo">059</span>        this.lastLogIndex = LongEncoder.read(buf);<a name="line.59"></a>
<span class="sourceLineNo">060</span>        this.checkArguments();<a name="line.60"></a>
<span class="sourceLineNo">061</span>    }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    @Override<a name="line.63"></a>
<span class="sourceLineNo">064</span>    void checkArguments() {<a name="line.64"></a>
<span class="sourceLineNo">065</span>        super.checkArguments();<a name="line.65"></a>
<span class="sourceLineNo">066</span>        Preconditions.checkArgument(this.leaderTimestamp != null);<a name="line.66"></a>
<span class="sourceLineNo">067</span>        Preconditions.checkArgument(this.matchIndex &gt;= -1);<a name="line.67"></a>
<span class="sourceLineNo">068</span>        Preconditions.checkArgument(this.matchIndex &lt;= this.lastLogIndex);<a name="line.68"></a>
<span class="sourceLineNo">069</span>    }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>// Properties<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Get the {@code leaderTimestamp} from the corresponding {@link AppendRequest}.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @return request leader timestamp<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @see AppendRequest#getLeaderTimestamp<a name="line.77"></a>
<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
<span class="sourceLineNo">079</span>    public Timestamp getLeaderTimestamp() {<a name="line.79"></a>
<span class="sourceLineNo">080</span>        return this.leaderTimestamp;<a name="line.80"></a>
<span class="sourceLineNo">081</span>    }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    /**<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * Determine whether the request was successful, i.e., the previous log entry term and index matched.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @return true if the corresponding request matched<a name="line.86"></a>
<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    public boolean isSuccess() {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        return this.success;<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Get the index of the most recent log entry known to match leader.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * In case of a successful request, this will be equal to the log entry sent (or the previous<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * log entry in case of a probe). In case of a failed request, this will be equal<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * to the follower's state machine last applied index.<a name="line.96"></a>
<span class="sourceLineNo">097</span>     *<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @return highest known matching log entry index<a name="line.98"></a>
<span class="sourceLineNo">099</span>     */<a name="line.99"></a>
<span class="sourceLineNo">100</span>    public long getMatchIndex() {<a name="line.100"></a>
<span class="sourceLineNo">101</span>        return this.matchIndex;<a name="line.101"></a>
<span class="sourceLineNo">102</span>    }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    /**<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * Get the index of the last log entry in the follower's log.<a name="line.105"></a>
<span class="sourceLineNo">106</span>     *<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @return last log entry index<a name="line.107"></a>
<span class="sourceLineNo">108</span>     */<a name="line.108"></a>
<span class="sourceLineNo">109</span>    public long getLastLogIndex() {<a name="line.109"></a>
<span class="sourceLineNo">110</span>        return this.lastLogIndex;<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>// Message<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    @Override<a name="line.115"></a>
<span class="sourceLineNo">116</span>    public void visit(MessageSwitch handler) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>        handler.caseAppendResponse(this);<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public void writeTo(ByteBuffer dest) {<a name="line.121"></a>
<span class="sourceLineNo">122</span>        super.writeTo(dest);<a name="line.122"></a>
<span class="sourceLineNo">123</span>        Message.putTimestamp(dest, this.leaderTimestamp);<a name="line.123"></a>
<span class="sourceLineNo">124</span>        Message.putBoolean(dest, this.success);<a name="line.124"></a>
<span class="sourceLineNo">125</span>        LongEncoder.write(dest, this.matchIndex);<a name="line.125"></a>
<span class="sourceLineNo">126</span>        LongEncoder.write(dest, this.lastLogIndex);<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span>    protected int calculateSize() {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        return super.calculateSize()<a name="line.131"></a>
<span class="sourceLineNo">132</span>          + Message.calculateSize(this.leaderTimestamp)<a name="line.132"></a>
<span class="sourceLineNo">133</span>          + 1<a name="line.133"></a>
<span class="sourceLineNo">134</span>          + LongEncoder.encodeLength(this.matchIndex)<a name="line.134"></a>
<span class="sourceLineNo">135</span>          + LongEncoder.encodeLength(this.lastLogIndex);<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>// Object<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>    @Override<a name="line.140"></a>
<span class="sourceLineNo">141</span>    public String toString() {<a name="line.141"></a>
<span class="sourceLineNo">142</span>        return this.getClass().getSimpleName()<a name="line.142"></a>
<span class="sourceLineNo">143</span>          + "[\"" + this.getSenderId() + "\"-&gt;\"" + this.getRecipientId() + "\""<a name="line.143"></a>
<span class="sourceLineNo">144</span>          + ",clusterId=" + String.format("%08x", this.getClusterId())<a name="line.144"></a>
<span class="sourceLineNo">145</span>          + ",term=" + this.getTerm()<a name="line.145"></a>
<span class="sourceLineNo">146</span>          + ",leaderTimestamp=" + this.leaderTimestamp<a name="line.146"></a>
<span class="sourceLineNo">147</span>          + ",success=" + this.success<a name="line.147"></a>
<span class="sourceLineNo">148</span>          + ",matchIndex=" + this.matchIndex<a name="line.148"></a>
<span class="sourceLineNo">149</span>          + ",lastLogIndex=" + this.lastLogIndex<a name="line.149"></a>
<span class="sourceLineNo">150</span>          + "]";<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span>}<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>




























































</pre>
</div>
</body>
</html>
